/*
Copyright (c) 2009, Young Digital Planet SA
All rights reserved.

* Redistribution and use in source and binary forms, with or without 
  modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this 
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, 
  this list of conditions and the following disclaimer in the documentation 
  and/or other materials provided with the distribution.
* Neither the name of the Young Digital Planet SA nor the names of its 
  contributors may be used to endorse or promote products derived from this 
  software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
*/
package com.yauthor.module
{
	import flash.display.DisplayObject;
	
	/**
	 * Dispatched when visualState property changes.
	 */
	[Event(name="propertyChange",type="pl.ydp.events.PropertyChangeEvent")]
	/**
	 * Skin used to display mark for an answer. It's view should
	 * be placed over elements of activity. In response to changes
	 * of visualState, view changes it's image to mark apropriate
	 * answer state. If activity has parts, each part can have
	 * it's own mark answer skin, which will be styled and controlled
	 * separately.
	 * <p>
	 * Skin can work in <ul>
	 * <li><i>detailed mode</i> - apperance is controlled by properties: 
	 * active, correctness, showAnswers, markCorrect, markWrong. Those 
	 * properties should be set during module lifetime and restored when
	 * module state is restored.
	 * <li>direct mode, when module is controlled by visualState property.
	 * This mode is for 
	 */
	public interface IMarkAnswerSkin
	{
		/**
		 * View that should be attached to activity. View should be
		 * attached above activity display layer and should be aligned
		 * to activity area. View implementation is dependend to player
		 * implementation - Utopia Flex implementation returns player
		 * that extends UIComponent.
		 */
		function get view():DisplayObject;
		
		/**
		 * Activate mark answer skin. Only after activation 
		 * skin can change it's state. Skin can be activated right
		 * after creation or i.e. when user enters gives an
		 * answer.
		 */
		function set active( a:Boolean ):void;
		
		/**
		 * Set answer correctness.
		 */
		function set correctness( c:Correctness ):void;
		
		/**
		 * Turn skin into showAnswers mode.
		 */
		function set showAnswers( sa:Boolean ):void;
		/**
		 * Turn skin into markCorrect mode.
		 */
		function set markCorrect( sa:Boolean ):void;
		/**
		 * Turn skin into markWrong mode.
		 */
		function set markWrong( sa:Boolean ):void;
		
		/**
		 * Set visual state of the component. This property changes
		 * visual apperance of skin. If you use this property, other
		 * properties are ignored and change is made immidiately. When
		 * other properties are set, visualState is recalculated and
		 * overwritten. Appropriate PropertyChangeEvent is sent.
		 */
		function set visualState( state:MarkAnswerSkinState ):void;
		function get visualState():MarkAnswerSkinState;
	}
}